feat(tracing): migrate logging to tracing #1308

ognis1205 · 2025-11-21T19:32:34Z

Description

This PR migrates the logging implementation from env_logger to tracing.

The migration preserves the existing log format while extending it to include span information, enabling more structured and contextual logging without changing the default user experience.

Motivation and Context

This change is motivated by the following discussion and issues:

Review of log level usage: promote certain trace! logs to info! to improve observability #1191
Migrate logging from env_logger to tracing + tracing-subscriber #1268

The goal is to modernize git-cliff's logging infrastructure by adopting tracing, while maintaining backward compatibility and avoiding unnecessary complexity in the core crate.

What Has Changed

The logger has been updated to emit spans in a format consistent with the existing log output.
Span instrumentation is applied only to methods that affect the changelog generator's semantics (e.g. changelog, release, and commit processing).
git-cliff-core now depends on tracing behind a feature flag.
- When the feature is disabled, the behavior is unchanged and only the existing log output is produced.
- When the feature is enabled, spans are created and included in the output.
Remote metadata progress reporting has been fully migrated to a tracing-based implementation using tracing-indicatif.
The progress bar implementation is intentionally kept simple.
- While richer progress reporting is possible with tracing, implementing such behavior cleanly would require API changes outside of git-cliff-core.
- Given the current API design, this PR avoids introducing additional complexity and leaves room for future design discussions.

How Has This Been Tested?

Existing unit tests were run.
Logging output was verified manually.

Screenshots / Logs (if applicable)

N/A

Types of Changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Documentation (no code change)
Refactor (refactoring production code)
Other

Checklist:

My code follows the code style of this project.
I have updated the documentation accordingly.
I have formatted the code with rustfmt.
I checked the lints with clippy.
I have added tests to cover my changes.
All new and existing tests passed.

codecov-commenter · 2025-11-21T19:37:06Z

Codecov Report

❌ Patch coverage is 0% with 77 lines in your changes missing coverage. Please review.
✅ Project coverage is 43.59%. Comparing base (eb99e41) to head (9ff9ae5).

Files with missing lines	Patch %	Lines
git-cliff/src/logger.rs	0.00%	72 Missing ⚠️
git-cliff-core/src/changelog.rs	0.00%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1308      +/-   ##
==========================================
+ Coverage   43.30%   43.59%   +0.30%     
==========================================
  Files          23       23              
  Lines        2245     2230      -15     
==========================================
  Hits          972      972              
+ Misses       1273     1258      -15

Flag	Coverage Δ
unit-tests	`43.59% <0.00%> (+0.30%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

orhun · 2025-11-21T19:38:27Z

10 seconds ago I was happy that my GitHub notifications were clear and then Shingo comes in with a crazy PR!!!!!

+0 additions -0 deletions though. Love it. LGTM

orhun · 2025-12-14T12:56:53Z

planning to do any progress on this soon? (added to 2.12.0 milestone)

ognis1205 · 2025-12-15T02:14:44Z

planning to do any progress on this soon? (added to 2.12.0 milestone)

Yeah, I'm planning to open a PR later this week.
Does that timeline work for the 2.12.0 milestone?

orhun · 2025-12-15T07:21:19Z

yup, 2.12.0 will happen in 2026 :)
so we have a whole year!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

ognis1205 · 2025-12-20T18:28:18Z

Sorry for the delay. I'll start working on this PR today.

orhun · 2025-12-20T21:13:40Z

No worries at all!

ognis1205 · 2026-01-13T13:46:12Z

This is ready for review now @orhun .

I consider this a first draft, and there are likely areas open for discussion. When you have time, I'd really appreciate your thoughts and feedback.

ognis1205

TODO:

Replace all ASCII color codes with owo_colors.
Consider how to handle Windows and non-TTY environments (this may also have been an issue in the previous implementation).

orhun · 2026-01-17T09:47:57Z

git-cliff/src/logger.rs

 static MAX_MODULE_WIDTH: AtomicUsize = AtomicUsize::new(0);

+/// Unicode braille spinner frames used by indicatif.
+const SPINNER_TICKS: &[&str] = &["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"];


Would be great if we could keep the old arrow-styled progress indicator (for the first line in the logs at least)

I really like the detailed logging btw!

Let me know when this is ready for review

Would be great if we could keep the old arrow-styled progress indicator (for the first line in the logs at least)

That should be doable.

We can bring back the old arrow-style progress indicator, but when implemented on top of tracing / span-based instrumentation via tracing-indicatif, it would look slightly different from the previous approach:

If that's acceptable, I'm happy to revert the change accordingly. In addition to the progress indicator itself, we can of course also emit explicit logs at the beginning and end of the processing step.

In an ideal world, I'd like to include a progress indicator with percentages as well. However, with the current design, where spans and logging live inside the core SDK, that starts to get a bit messy from a design perspective. It's technically possible, but I intentionally avoided it for now to keep the core clean.

Let me know when this is ready for review

Regarding ANSI/ASCII color codes on Windows or non-TTY environments: since we were already using colored output before, I think it's reasonable to review this as-is for now.

If you're open to it, I'd really appreciate review feedback on the following points in the context of adding this to git-cliff-core as an SDK:

Which functions should be annotated with #[instrument] (all vs. a subset)

Whether span names should be explicitly set

Which fields are appropriate to capture on spans

From a "keep git-cliff-core as a clean SDK" perspective, another option could be to explore whether progress reporting can be handled in a less hacky way on top of env_logger, if that's feasible. Just putting it out there as an alternative.

Signed-off-by: Shingo OKAWA <[email protected]>

…ntics Signed-off-by: Shingo OKAWA <[email protected]>

Signed-off-by: Shingo OKAWA <[email protected]>

ognis1205 marked this pull request as draft November 21, 2025 19:32

orhun added this to the 2.12.0 milestone Dec 14, 2025

ognis1205 force-pushed the feat/migrate-to-tracing branch from 5bb0f7b to f6b930d Compare December 20, 2025 21:30

ognis1205 force-pushed the feat/migrate-to-tracing branch from f6b930d to b273940 Compare January 3, 2026 19:54

ognis1205 force-pushed the feat/migrate-to-tracing branch from b273940 to b1e9f80 Compare January 12, 2026 17:02

ognis1205 marked this pull request as ready for review January 13, 2026 13:44

ognis1205 requested a review from orhun as a code owner January 13, 2026 13:44

ognis1205 commented Jan 13, 2026

View reviewed changes

ognis1205 force-pushed the feat/migrate-to-tracing branch 2 times, most recently from 75b4d8d to b53b100 Compare January 16, 2026 12:36

orhun reviewed Jan 17, 2026

View reviewed changes

ognis1205 force-pushed the feat/migrate-to-tracing branch from b53b100 to 7367d4b Compare January 18, 2026 16:02

ognis1205 added 10 commits January 19, 2026 21:30

chore: initial draft commit

853fbbe

Signed-off-by: Shingo OKAWA <[email protected]>

feat/migrate env_logger to tracing

94fb8e5

Signed-off-by: Shingo OKAWA <[email protected]>

fix: cargo optional dependency

c79e04e

Signed-off-by: Shingo OKAWA <[email protected]>

fix: lint

3e893b6

Signed-off-by: Shingo OKAWA <[email protected]>

feat: add spans to remote module

747cc3a

Signed-off-by: Shingo OKAWA <[email protected]>

feat: add spans to changelog module

57630ff

Signed-off-by: Shingo OKAWA <[email protected]>

feat: add spans to command module

afff57b

Signed-off-by: Shingo OKAWA <[email protected]>

feat: add spans to commit module

a1fb90d

Signed-off-by: Shingo OKAWA <[email protected]>

feat: add spans to config module

d79f992

Signed-off-by: Shingo OKAWA <[email protected]>

feat: add spans to release module

b18cfb1

Signed-off-by: Shingo OKAWA <[email protected]>

ognis1205 added 4 commits January 19, 2026 21:30

refactor(tracing): limit instrumentation to changelog generation sema…

670a040

…ntics Signed-off-by: Shingo OKAWA <[email protected]>

refactor(tracing): pretty format

91e161c

Signed-off-by: Shingo OKAWA <[email protected]>

fix: typo

5b1d8aa

Signed-off-by: Shingo OKAWA <[email protected]>

fix: clamp interpolated color values to valid u8 range

9ff9ae5

Signed-off-by: Shingo OKAWA <[email protected]>

ognis1205 force-pushed the feat/migrate-to-tracing branch from 7367d4b to 9ff9ae5 Compare January 19, 2026 12:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(tracing): migrate logging to tracing #1308

feat(tracing): migrate logging to tracing #1308

Uh oh!

ognis1205 commented Nov 21, 2025 •

edited

Loading

Uh oh!

codecov-commenter commented Nov 21, 2025 •

edited

Loading

Uh oh!

orhun commented Nov 21, 2025

Uh oh!

orhun commented Dec 14, 2025

Uh oh!

ognis1205 commented Dec 15, 2025

Uh oh!

orhun commented Dec 15, 2025

Uh oh!

ognis1205 commented Dec 20, 2025

Uh oh!

orhun commented Dec 20, 2025

Uh oh!

ognis1205 commented Jan 13, 2026

Uh oh!

ognis1205 left a comment •

edited

Loading

Uh oh!

orhun Jan 17, 2026

Uh oh!

ognis1205 Jan 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

feat(tracing): migrate logging to tracing #1308

Are you sure you want to change the base?

feat(tracing): migrate logging to tracing #1308

Uh oh!

Conversation

ognis1205 commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

What Has Changed

How Has This Been Tested?

Screenshots / Logs (if applicable)

Types of Changes

Checklist:

Uh oh!

codecov-commenter commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

orhun commented Nov 21, 2025

Uh oh!

orhun commented Dec 14, 2025

Uh oh!

ognis1205 commented Dec 15, 2025

Uh oh!

orhun commented Dec 15, 2025

Uh oh!

ognis1205 commented Dec 20, 2025

Uh oh!

orhun commented Dec 20, 2025

Uh oh!

ognis1205 commented Jan 13, 2026

Uh oh!

ognis1205 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

orhun Jan 17, 2026

Choose a reason for hiding this comment

Uh oh!

ognis1205 Jan 18, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ognis1205 commented Nov 21, 2025 •

edited

Loading

codecov-commenter commented Nov 21, 2025 •

edited

Loading

ognis1205 left a comment •

edited

Loading